Skip to main content

Running a project

This page assumes you have cloned the repo of the project you want to work on.

Working on an existing website?

Make sure to check the README.md in the root of the repository you're working on, since it might be different from our latest standards.

Make sure you have all prerequisites installed on your system:

  • nvm (optional, but recommended)
  • Node.js (see .nvmrc for version, prefer installing via nvm)
  • PHP and Composer (latest version)
  • Docker Desktop

Install the packages of this repository (first time and everytime packages are updated):

npm i # installs front-end packages for build and some local development tools
composer install # installs PHP dependencies (mainly WordPress plugins)

Starting the local server:​

docker-compose up # starts a PHP environment with MySQL for running WordPress
npm start # starts a front-end development watcher/server using webpack

Optional: Enable debug mode in Docker:​

$ apt-get update
$ apt-get install vim
$ cd /var/www/html/
$ vim wp-config.php
$ set WP_DEBUG to `true`
$ Click ESC and :wq to save and exit.